Repository navigation
fix(connectors): reuse the GitHub App OAuth client for the github connector - #7955
Merged
Merged
Conversation
…nector PLUGIN_GITHUB_CLIENT_ID and PLUGIN_GITHUB_CLIENT_SECRET were never set as GitHub secrets, so both deploy workflows passed empty strings and connectorEnv() threw MissingConnectorEnvError on every attempt to connect the GitHub plugin. GH_APP_CLIENT_ID and GH_APP_CLIENT_SECRET already exist as repo secrets and already reach the API through both workflows, so point requires_env at them and drop the unused pair from the templates and the deploy plumbing.
harshithmullapudi
temporarily deployed
to
preview
September 30, 2026 01:08 — with
GitHub Actions
Inactive
Contributor
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (5)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
harshithmullapudi
temporarily deployed
to
preview
September 30, 2026 01:08 — with
GitHub Actions
Inactive
harshithmullapudi
temporarily deployed
to
preview
September 30, 2026 01:08 — with
GitHub Actions
Inactive
harshithmullapudi
temporarily deployed
to
preview
September 30, 2026 01:08 — with
GitHub Actions
Inactive
harshithmullapudi
temporarily deployed
to
preview
September 30, 2026 01:08 — with
GitHub Actions
Inactive
harshithmullapudi
temporarily deployed
to
preview
September 30, 2026 01:08 — with
GitHub Actions
Inactive
|
No installed development build can load this pull request as an update: its native fingerprint is |
Contributor
🚀 Preview Deployment🔗 Preview Links
Preview updates automatically with new commits |
Kitenite
added a commit
that referenced
this pull request
Oct 1, 2026
* docs: weekly update for PRs merged 2026-09-23 to 2026-09-30 Source of truth: live Notion SOP "Weekly Docs Update (automation SOP)". Window: merged:>=2026-09-23 (139 PRs). PRs through the morning of 09-23 were covered by #7771. Changes - Pages: no auto-open on publish (#7790); page links and URL links split into their own settings (#7916, #7962, #7946); Listening agents menu with per-row stop and Add listening agent (#7724, #7820, #7919); globe on the Share button (#7766); Report on public pages (#7886); agents offer a page (#7759). Files: pages.mdx, cli/cli-reference.mdx. - Settings moves: Links replaced by Browser and Files & Editor (#7916, #7962). Files: editor.mdx, terminal-integration.mdx, customization.mdx. - Editor: inline rename and drag to move (#7692), Auto Save (#7693, #7916), open and save files outside the workspace (#7897, #7982), Copy as Markdown (#7591), per-pane error screen (#7983). File: editor.mdx. - Terminal copy follows Ghostty's whitespace rules (#7868). File: terminal-integration.mdx. - Agents: UFO (#7898); GPT-6 Astra, Sonnet 5.5, retiring GPT-5.5, retired GPT-5.4/5.3 Codex (#7783, #7894, #7935). Files: agent-integration.mdx, cli/cli-reference.mdx. - Host: superset start --daemon --auto-update and update-lock permission errors (#7735, #7952). Files: cli/host-server.mdx, cli/cli-reference.mdx. - Removed the mcp CLI section and the Connected Service Plugins section: #7776 made plugins/mcp internal, the Plugins page is staff-flagged, and apps/docs/AGENTS.md keeps internal commands out. Files: skills.mdx, cli/cli-reference.mdx. - Slack page unfurls and details panel (#7817, #7821, #7914, #7957). File: use-with-slack.mdx. - Workspaces: instant creation with background naming (#7518); recoverable project deletion (#7896). File: workspaces.mdx. - Shortcuts: prev/next workspace includes Pinned and wraps (#7851); ⌘B collapses the sidebar to a rail (#7964). File: keyboard-shortcuts.mdx. - Ship controls and open-in button moved to the right sidebar strip (#7958). Files: diff-viewer.mdx, use-with-ide.mdx. Deliberately skipped - Cloud workspaces/environments/sandboxes (flag-gated, AGENTS.md rule): #7784 #7795 #7824 #7840 #7844 #7845 #7847 #7849 #7850 #7858 #7861 #7863 #7874 #7911 #7913 #7918 #7922 #7931 #7932 #7937 #7956 #7961 #7969 #7981 #7637 #7794 #7789 #7838 (its CLI docs already shipped in the PR). - Staff-only plugins: #7912 Sentry plugin, #7716, #7727, #7955. - Already documented in their own PRs: #7917, #7921. - Removed feature never documented: #7796 Google Calendar triggers. - Agents chip remove/revert/default-off, never documented: #7870 #7871 #7872. - Billing/backend policy with no docs surface: #7947, #7812, #7786, #7792, #7798, #7761, #7948, #7949, #7951, #7827. - Reverted security trio: #7828 #7829 #7830 (reverted by #7834). - Fixes restoring expected behavior: #7683 #7696 #7707 #7743 #7751 #7756 #7764 #7765 #7781 #7788 #7791 #7823 #7825 #7833 #7837 #7852 #7857 #7860 #7864 #7865 #7869 #7873 #7897-covered #7903 #7938 #7980 #7943 #7964-chrome. - Mobile (no docs page): #7746 #7747 #7748 #7749 #7750 #7782 #7793 #7810 #7814 #7816 #7889 #7968. - Marketing, internal docs, CI, version bumps: #7651 #7744 #7752 #7771 #7774 #7776-infra #7777 #7785 #7811 #7818 #7822 #7826 #7834 #7884 #7885 #7895 #7909 #7933 #7934 #7942 #7944 #7965 #7966. Validation: bun run --cwd apps/docs typecheck, bun run lint:fix, bun run lint (exit 0), Vale on 13 changed files (0 errors, 0 warnings), git diff --check. * chore: log weekly docs update follow-ups * docs: tighten review findings in the weekly update Only the page creator can stop or add listening agents. On focus change also saves on window blur, and Auto Save pauses on conflicts. Taken-down pages do not unfurl. Model picker coverage matches agent-models.ts.
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
githubconnector'srequires_envatGH_APP_CLIENT_ID/GH_APP_CLIENT_SECRETinstead ofPLUGIN_GITHUB_CLIENT_ID/PLUGIN_GITHUB_CLIENT_SECRET.PLUGIN_GITHUB_*pair from both env templates and both deploy workflows.Why / Context
Connecting the GitHub plugin fails in production. The
githubconnector declares:and
connectorEnv()(packages/trpc/src/lib/connectors/index.ts:71) throws on any falsy value:Neither secret has ever existed. There are zero
PLUGIN_*secrets insuperset-sh/superset— not repo-level (88 secrets), not in theProductionenvironment (62), not inPreview. TheapiVercel project holds onlyGITHUB_TOKENandYC_DEALS_WEBHOOK_SECRET. Both workflows wired the pair correctly (env:block and--envflag), so they faithfully passed empty strings through.This went unnoticed because neither name appears in any env schema —
packages/trpc/src/env.tsdeclares onlyPLUGIN_CLIENT_METADATA_BASE_URL, and as.optional(). The API boots clean and fails only when a user clicks Connect, which is exactly the silent-failure modedocs/environment-variables.mdstep 2 warns about.GH_APP_CLIENT_ID/GH_APP_CLIENT_SECRETare already real repo secrets, already in the env schema, already in both templates with fake local values, and already passed to the API by both deploy workflows. Reusing them fixes the connector with no new secret and no new plumbing.How It Works
clientCredentials()derives the secret's name from the id's, so the rename needs no code change:GH_APP_CLIENT_ID→GH_APP_CLIENT_SECRET, both resolved fromprocess.env.The env-var checklist in
docs/environment-variables.mdis satisfied in both directions: the removed pair is gone from all five places (it only ever reached places 3 and 5), and the newly-referenced pair is already present in all five.The GitHub App must list the connector callback URL. Add
to the Superset GitHub App's callback URLs (Apps support up to 10). Without it the redirect fails with
The redirect_uri MUST match the registered callback URL. This PR cannot do that — it is a GitHub App setting.Production also needs a redeploy after merge to pick up the changed
connectors.json.Known Limitations
scopeparameter. The connector still declares"scopes": ["repo", "read:org", "workflow"], but a GitHub App's user-authorization flow derives access from the App's configured permissions and its installations, not from classic OAuth scopes. So thatscopesarray becomes dead config, and the resulting user token can only reach repositories where the Superset App is installed — narrower than a classic OAuth app would grant. If the GitHub plugin's MCP server (https://api.githubcopilot.com/mcp/) needs broader reach, the right fix is a dedicated OAuth app plus setting thePLUGIN_GITHUB_*secrets, i.e. reverting this PR. I leftscopesin place rather than deleting it, to keep that revert clean.refresh.tshandles the refresh grant against the sametoken_url, but this path has not been exercised in production.GH_APP_CLIENT_IDstays.optional()in the schema. That matchesSENTRY_CLIENT_IDandMICROSOFT_CLIENT_ID, andMissingConnectorEnvErroralready gives a clear failure, so I did not promote it to required.Testing
bun run lint— clean (8828 files)bunx turbo typecheck --filter=@superset/shared --filter=@superset/trpc— 3/3 successfulbun test packages/shared/src/connectors packages/trpc/src/lib/connectors— 44 pass, 0 fail (includes the registry-schema validation ofconnectors.json)bun run check:plugins— "All plugins are valid and published"Not verified: the OAuth flow end to end. That needs the callback URL registered on the GitHub App and a production deploy, neither of which I can do from here. I also did not run a YAML linter (
actionlintis not installed); the workflow edits are four two-line deletions from the middle of flat lists, and the--envshell continuation chain stays intact on both sides of each deletion.Manual QA Checklist
$.login)Risks / Rollout
PLUGIN_GITHUB_*. The GitHub App's existing sign-in and repo-integration flows are untouched; this only adds a second consumer of the same client credentials.PLUGIN_GITHUB_*set as secrets — the revert restores exactly that wiring.Summary by cubic
Fixes the GitHub connector, which threw
MissingConnectorEnvErroron every connect becausePLUGIN_GITHUB_CLIENT_IDandPLUGIN_GITHUB_CLIENT_SECRETwere never set as repository secrets. The connector now reuses the existingGH_APP_CLIENT_ID/GH_APP_CLIENT_SECRETpair, and the unusedPLUGIN_GITHUB_*pair is dropped from the env templates and both deploy workflows.Required before this works
https://api.boid.so/api/connectors/callback/githubas a callback URL on the Superset GitHub App, then redeploy production.Known limitations
scopeparameter, so the declaredscopesare dead config and access is limited to repos where the App is installed.Written for commit acb4bf3. Summary will update on new commits.
Summary by CodeRabbit